Skip to content

PD-1967 / 25.10 / Pd 1967 rename scalereleasenotes #4198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 6 commits into
base: 25.10
Choose a base branch
from
Open

PD-1967 / 25.10 / Pd 1967 rename scalereleasenotes #4198

wants to merge 6 commits into from

Conversation

DjP-iX
Copy link
Contributor

@DjP-iX DjP-iX commented Oct 2, 2025

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

@DjP-iX DjP-iX requested a review from a team as a code owner October 2, 2025 15:28
@bugclerk bugclerk changed the title Pd 1967 rename scalereleasenotes PD-1967 / 25.10 / Pd 1967 rename scalereleasenotes Oct 2, 2025
@bugclerk
Copy link
Contributor

bugclerk commented Oct 2, 2025

Jira URL: https://ixsystems.atlassian.net/browse/PD-1967

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 2, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)
Vale Style Guide Issues (Previous - Click to expand)
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 1579 issues found in changed files - 72 errors, 32 warnings, 1475 suggestions

Changed files with issues:

words-to-ignore.txt (536 issues)

  • Line 1 - suggestion: Keep sentences under 30 words
  • Line 5 - suggestion: Spell out 'NAS' on first use
  • Line 10 - suggestion: Spell out 'WSL' on first use
  • Line 29 - suggestion: Spell out 'ALUA' on first use
  • Line 30 - suggestion: Spell out 'MTU' on first use
  • Line 34 - suggestion: Spell out 'LUN' on first use
  • Line 36 - suggestion: Spell out 'SATA' on first use
  • Line 37 - suggestion: Spell out 'OSI' on first use
  • Line 38 - suggestion: Spell out 'PDU' on first use
  • Line 50 - suggestion: Spell out 'AHIC' on first use
  • Line 52 - suggestion: Spell out 'VNC' on first use
  • Lines 53, 54 - suggestion: Spell out 'UEFI' on first use
  • Line 60 - suggestion: Spell out 'SDLC' on first use
  • Line 62 - suggestion: Spell out 'VNET' on first use
  • Line 64 - suggestion: Spell out 'VMFS' on first use
  • Line 65 - error: 'Virtualized' is repeated!
  • Line 71 - suggestion: Spell out 'DAC' on first use
  • Lines 72, 73 - suggestion: Spell out 'QSFP' on first use
  • Line 75 - suggestion: Spell out 'SSD' on first use
  • Line 77 - suggestion: Spell out 'SED' on first use
  • Line 85 - suggestion: Spell out 'TBD' on first use
  • Line 87 - error: 'ZFS' is repeated!
  • Line 88 - suggestion: Spell out 'ZFS' on first use
  • Line 93 - suggestion: Spell out 'SMB' on first use
  • Line 94 - suggestion: Spell out 'AAPL' on first use
  • Line 97 - suggestion: Spell out 'IPMI' on first use
  • Line 98 - suggestion: Spell out 'VLAN' on first use
  • Line 116 - error: 'MinIO' is repeated!
  • Line 127 - suggestion: Spell out 'FSCTL' on first use
  • Line 129 - suggestion: Spell out 'ACL' on first use
  • Line 134 - error: 'RX' is repeated!
  • Line 143 - suggestion: Spell out 'CVE' on first use
  • Line 148 - suggestion: Spell out 'NIS' on first use
  • Line 150 - suggestion: Spell out 'HWPMC' on first use
  • Line 162 - suggestion: Spell out 'MCA' on first use
  • Line 163 - suggestion: Spell out 'APEI' on first use
  • Line 164 - suggestion: Spell out 'EPCT' on first use
  • Line 165 - suggestion: Spell out 'NVM' on first use
  • Line 174 - suggestion: Spell out 'RTL' on first use
  • Line 178 - suggestion: Spell out 'NIC' on first use
  • Line 179 - suggestion: Spell out 'JIRA' on first use
  • Lines 188, 504, 763, 1982, 2104 - suggestion: Avoid contractions in formal writing
  • Line 204 - error: 'nfs' is repeated!
  • Line 204 - suggestion: Spell out 'NFS' on first use
  • Line 222 - error: 'GELI' is repeated!
  • Line 223 - suggestion: Spell out 'GELI' on first use
  • Line 224 - suggestion: Spell out 'CSR' on first use
  • Line 229 - suggestion: Spell out 'RSFSR' on first use
  • Lines 232, 233 - suggestion: Spell out 'DHCP' on first use
  • Line 234 - suggestion: Spell out 'AFP' on first use
  • Line 241 - error: 'tunables' is repeated!
  • Line 246 - suggestion: Spell out 'CLI' on first use
  • Line 268 - suggestion: Spell out 'SME' on first use
  • Line 269 - suggestion: Spell out 'ECC' on first use
  • Line 282 - suggestion: Spell out 'BSG' on first use
  • Line 283 - suggestion: Spell out 'FBSG' on first use
  • Line 294 - suggestion: Spell out 'POSIX' on first use
  • Line 295 - suggestion: Spell out 'CIFS' on first use
  • Line 312 - suggestion: Spell out 'IEC' on first use
  • Lines 329, 411 - suggestion: Spell out 'ZIL' on first use
  • Lines 337, 2145 - suggestion: Spell out 'VPN' on first use
  • Line 340 - suggestion: Spell out 'DNS' on first use
  • Line 342 - error: 'hostname' is repeated!
  • Line 346 - suggestion: Spell out 'LDAP' on first use
  • Line 347 - suggestion: Spell out 'DDNS' on first use
  • Line 349 - suggestion: Spell out 'LLDP' on first use
  • Line 350 - suggestion: Spell out 'NDS' on first use
  • Line 351 - suggestion: Spell out 'NTP' on first use
  • Line 354 - suggestion: Spell out 'KMIP' on first use
  • Line 358 - suggestion: Spell out 'AFS' on first use
  • Line 361 - suggestion: Spell out 'AHCI' on first use
  • Line 362 - suggestion: Spell out 'ATA' on first use
  • Line 367 - suggestion: Spell out 'KVM' on first use
  • Line 368 - suggestion: Spell out 'MBR' on first use
  • Line 369 - suggestion: Spell out 'CSM' on first use
  • Line 382 - suggestion: Spell out 'SFTP' on first use
  • Line 383 - suggestion: Spell out 'UDP' on first use
  • Line 385 - suggestion: Spell out 'SNMP' on first use
  • Line 387 - suggestion: Spell out 'TLS' on first use
  • Line 405 - suggestion: Spell out 'MLC' on first use
  • Line 408 - suggestion: Spell out 'SDC' on first use
  • Line 410 - suggestion: Spell out 'TXG' on first use
  • Line 412 - suggestion: Spell out 'IOPS' on first use
  • Line 414 - suggestion: Spell out 'VDEV' on first use
  • Line 425 - suggestion: Spell out 'VSS' on first use
  • Line 427 - suggestion: Spell out 'OSX' on first use
  • Line 428 - error: 'deduplication' is repeated!
  • Line 435 - error: 'Filesystems' is repeated!
  • Line 445 - suggestion: Spell out 'EVO' on first use
  • Line 457 - suggestion: Spell out 'SHA' on first use
  • Line 457 - error: 'sha' is repeated!
  • Line 459 - suggestion: Spell out 'NVRAM' on first use
  • Line 464 - suggestion: Spell out 'JBOD' on first use
  • Line 465 - suggestion: Spell out 'MTTDL' on first use
  • Line 467 - error: 'Resilvering' is repeated!
  • Lines 478, 545 - suggestion: Spell out 'DFS' on first use
  • Line 493 - suggestion: Spell out 'PCI' on first use
  • Line 495 - suggestion: Spell out 'EDK' on first use
  • Line 496 - suggestion: Spell out 'INIT' on first use
  • Line 497 - suggestion: Spell out 'ALLOC' on first use
  • Line 516 - suggestion: Spell out 'TNS' on first use
  • Line 517 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 524 - suggestion: Spell out 'QEMU' on first use
  • Line 529 - suggestion: Spell out 'ESC' on first use
  • Line 576 - suggestion: Spell out 'DMA' on first use
  • Line 594 - suggestion: Spell out 'SPN' on first use
  • Line 596 - suggestion: Spell out 'EZFS' on first use
  • Line 597 - suggestion: Spell out 'NOCAP' on first use
  • Line 613 - suggestion: Spell out 'EUI' on first use
  • Line 614 - suggestion: Spell out 'IQN' on first use
  • Line 619 - suggestion: Spell out 'SFP' on first use
  • Line 620 - suggestion: Spell out 'LSO' on first use
  • Line 621 - suggestion: Spell out 'LRO' on first use
  • Line 626 - suggestion: Spell out 'PSU' on first use
  • Line 628 - suggestion: Spell out 'LACP' on first use
  • Line 632 - suggestion: Spell out 'BMC' on first use
  • Line 634 - suggestion: Spell out 'EPYC' on first use
  • Lines 637, 709 - suggestion: Spell out 'AES' on first use
  • Lines 641, 643, 644 - suggestion: Spell out 'SAS' on first use
  • Line 645 - suggestion: Spell out 'STP' on first use
  • Line 651 - suggestion: Spell out 'BBU' on first use
  • Line 652 - suggestion: Spell out 'HBA' on first use
  • Line 656 - suggestion: Spell out 'LSI' on first use
  • Line 661 - suggestion: Spell out 'CRC' on first use
  • Line 662 - suggestion: Spell out 'UDMA' on first use
  • Line 665 - suggestion: Spell out 'DIF' on first use
  • Line 675 - error: 'multipath' is repeated!
  • Line 680 - suggestion: Spell out 'PMR' on first use
  • Line 681 - suggestion: Spell out 'CMR' on first use
  • Line 689 - suggestion: Spell out 'LZJB' on first use
  • Line 691 - suggestion: Spell out 'ZLE' on first use
  • Line 693 - suggestion: Spell out 'ZSTD' on first use
  • Line 705 - suggestion: Spell out 'TFTP' on first use
  • Line 716 - suggestion: Spell out 'MMC' on first use
  • Line 717 - suggestion: Spell out 'UTF' on first use
  • Line 732 - suggestion: Spell out 'FXP' on first use
  • Line 734 - suggestion: Spell out 'PASV' on first use
  • Line 736 - suggestion: Spell out 'FQDN' on first use
  • Line 737 - suggestion: Spell out 'PEM' on first use
  • Line 741 - error: 'IDENT' is repeated!
  • Line 742 - suggestion: Spell out 'IDENT' on first use
  • Line 747 - error: 'CheckIP' is repeated!
  • Line 760 - suggestion: Spell out 'SMTP' on first use
  • Line 762 - suggestion: Spell out 'FIPS' on first use
  • Line 783 - error: 'VMM' is repeated!
  • Line 784 - suggestion: Spell out 'VMM' on first use
  • Line 792 - suggestion: Spell out 'IPC' on first use
  • Line 796 - suggestion: Spell out 'SYSV' on first use
  • Line 802 - error: 'Chmod' is repeated!
  • Line 816 - error: 'autoconfigure' is repeated!
  • Line 819 - suggestion: Spell out 'BPF' on first use
  • Line 820 - suggestion: Spell out 'SLAAC' on first use
  • Lines 826, 2055 - suggestion: Spell out 'UUID' on first use
  • Line 830 - error: 'VDevs' is repeated!
  • Line 835 - suggestion: Spell out 'PBKDF' on first use
  • Line 848 - suggestion: Spell out 'PTR' on first use
  • Line 849 - suggestion: Spell out 'CTDB' on first use
  • Line 869 - suggestion: Spell out 'RBAC' on first use
  • Line 870 - warning: Avoid using 'TrueCommand's'
  • Line 871 - suggestion: Spell out 'CSV' on first use
  • Line 890 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 897 - suggestion: Spell out 'SAML' on first use
  • Line 924 - suggestion: Spell out 'CORS' on first use
  • Line 929 - suggestion: Spell out 'GORM' on first use
  • Line 932 - error: 'Ux' is repeated!
  • Line 937 - suggestion: Spell out 'SNI' on first use
  • Line 943 - warning: Avoid using 'API's'
  • Line 954 - error: 'Hyperconverged' is repeated!
  • Line 958 - suggestion: Spell out 'HCI' on first use
  • Line 1000 - suggestion: Spell out 'BTIME' on first use
  • Line 1024 - suggestion: Spell out 'NTB' on first use
  • Line 1032 - suggestion: Spell out 'KDC' on first use
  • Line 1039 - suggestion: Spell out 'RSS' on first use
  • Line 1043 - suggestion: Spell out 'NDP' on first use
  • Line 1054 - suggestion: Spell out 'STIG' on first use
  • Line 1063 - suggestion: Spell out 'OOB' on first use
  • Line 1068 - suggestion: Spell out 'OTP' on first use
  • Line 1074 - suggestion: Spell out 'HPE' on first use
  • Line 1120 - suggestion: Spell out 'GIDS' on first use
  • Line 1121 - suggestion: Spell out 'UIDS' on first use
  • Line 1131 - suggestion: Spell out 'PID' on first use
  • Line 1132 - suggestion: Spell out 'VID' on first use
  • Lines 1150, 2060, 2134 - suggestion: Spell out 'CMD' on first use
  • Line 1150 - suggestion: Spell out 'LINE' on first use
  • Line 1165 - warning: Prefer 'Gbps' over 'GBps'.
  • Lines 1166, 1167 - suggestion: Spell out 'IDP' on first use
  • Line 1216 - suggestion: Spell out 'SMR' on first use
  • Line 1217 - suggestion: Spell out 'ACPI' on first use
  • Line 1248 - suggestion: Spell out 'HSTS' on first use
  • Line 1258 - suggestion: Spell out 'CRIT' on first use
  • Line 1260 - suggestion: Spell out 'AMD' on first use
  • Line 1261 - suggestion: Spell out 'SVM' on first use
  • Line 1334 - suggestion: Spell out 'IXGBE' on first use
  • Line 1341 - suggestion: Spell out 'ECR' on first use
  • Line 1344 - suggestion: Spell out 'ASYNC' on first use
  • Line 1345 - suggestion: Spell out 'IOSQE' on first use
  • Line 1349 - error: 'MicroServer' is repeated!
  • Line 1354 - suggestion: Spell out 'IBS' on first use
  • Line 1368 - error: 'Rebalancing' is repeated!
  • Line 1382 - suggestion: Spell out 'WIP' on first use
  • Line 1386 - suggestion: Spell out 'TPC' on first use
  • Line 1440 - suggestion: Spell out 'SASL' on first use
  • Line 1458 - error: 'Webhook' is repeated!
  • Line 1462 - error: 'MatterMost' is repeated!
  • Line 1468 - error: 'ARN' is repeated!
  • Line 1469 - suggestion: Spell out 'ARN' on first use
  • Line 1470 - suggestion: Spell out 'SNS' on first use
  • Line 1477 - suggestion: Spell out 'MNMD' on first use
  • Line 1479 - suggestion: Spell out 'GMAIL' on first use
  • Line 1479 - error: 'gmail' is repeated!
  • Line 1482 - error: 'oauth' is repeated!
  • Line 1484 - suggestion: Spell out 'OAUTH' on first use
  • Line 1505 - suggestion: Spell out 'DTYP' on first use
  • Line 1516 - error: 'FSeriesStencil' is repeated!
  • Line 1535 - error: 'mydata' is repeated!
  • Lines 1545, 1605 - warning: Prefer 'GB' over 'Gb'.
  • Line 1566 - suggestion: Spell out 'OOBM' on first use
  • Line 1571 - suggestion: Spell out 'XOOBM' on first use
  • Line 1589 - error: 'NVDIMMUpdates' is repeated!
  • Line 1614 - error: 'gb' is repeated!
  • Line 1615 - warning: Prefer 'GB' over 'gb'.
  • Line 1650 - suggestion: Spell out 'HPC' on first use
  • Line 1667 - suggestion: Spell out 'BSOV' on first use
  • Line 1668 - error: 'misconfiguration' is repeated!
  • Line 1678 - error: 'discoverability' is repeated!
  • Line 1691 - suggestion: Spell out 'LXC' on first use
  • Line 1708 - suggestion: Spell out 'PUM' on first use
  • Line 1709 - suggestion: Spell out 'PRG' on first use
  • Line 1719 - suggestion: Spell out 'DACL' on first use
  • Line 1720 - suggestion: Spell out 'SACL' on first use
  • Line 1744 - suggestion: Spell out 'CSI' on first use
  • Line 1778 - suggestion: Spell out 'TUI' on first use
  • Line 1811 - suggestion: Spell out 'VLANS' on first use
  • Line 1826 - suggestion: Spell out 'NUMA' on first use
  • Lines 1833, 1848 - suggestion: Spell out 'MSR' on first use
  • Line 1835 - warning: Avoid using 'GPU's'
  • Line 1835 - suggestion: Spell out 'GPU' on first use
  • Line 1851 - suggestion: Spell out 'ROM' on first use
  • Line 1890 - error: 'hseries' is repeated!
  • Line 1895 - error: 'hseriesstencil' is repeated!
  • Line 1898 - error: 'hseriessov' is repeated!
  • Line 1900 - error: 'minirsov' is repeated!
  • Line 1914 - error: 'npum' is repeated!
  • Line 1914 - suggestion: Spell out 'NPUM' on first use
  • Line 1916 - error: 'nstencil' is repeated!
  • Line 1921 - suggestion: Spell out 'IANA' on first use
  • Line 1926 - suggestion: Spell out 'IEE' on first use
  • Line 1927 - error: 'ipsec' is repeated!
  • Line 1935 - suggestion: Spell out 'TTL' on first use
  • Line 1936 - suggestion: Spell out 'PIM' on first use
  • Line 1937 - error: 'stateful' is repeated!
  • Line 1942 - warning: 'publicly-accessible' doesn't need a hyphen.
  • Line 1942 - suggestion: Verify your use of 'accessible' with the A-Z word list.
  • Line 1943 - error: 'Unicast' is repeated!
  • Line 1955 - suggestion: Spell out 'NAA' on first use
  • Line 1957 - suggestion: Spell out 'FFF' on first use
  • Line 1964 - error: 'TruenasApps' is repeated!
  • Line 2029 - suggestion: Spell out 'TTY' on first use
  • Line 2058 - suggestion: Spell out 'ENV' on first use
  • Line 2060 - suggestion: Spell out 'SHELL' on first use
  • Line 2079 - suggestion: Spell out 'CHOWN' on first use
  • Line 2141 - suggestion: Spell out 'FSA' on first use
  • Line 2142 - error: 'zerotier' is repeated!
  • Line 2144 - error: 'VPN' is repeated!
  • Line 2146 - error: 'tailscale' is repeated!
  • Line 2157 - suggestion: Spell out 'SOV' on first use
  • Line 2165 - suggestion: Spell out 'DDT' on first use
  • Line 2165 - error: 'ddt' is repeated!
  • Line 2167 - error: 'ddts' is repeated!
  • Line 2169 - suggestion: Spell out 'ZAP' on first use
  • Line 2170 - suggestion: Spell out 'ARC' on first use
  • Line 2171 - error: 'dbit' is repeated!
  • Line 2173 - error: 'ZFSDeduplication' is repeated!
  • Line 2175 - error: 'ZFSPrimer' is repeated!
  • Line 2177 - error: 'ZILandSLOG' is repeated!
  • Line 2232 - suggestion: Spell out 'TPM' on first use
  • Line 2263 - suggestion: Spell out 'BMPUM' on first use
  • Line 2271 - error: 'iXVolumes' is repeated!
  • Line 2290 - suggestion: Spell out 'BLK' on first use
  • Line 2291 - suggestion: Spell out 'SCSI' on first use
  • Line 2302 - error: 'Cksum' is repeated!
  • Line 2371 - suggestion: Spell out 'GTX' on first use
  • Line 2372 - suggestion: Spell out 'RTX' on first use
  • Line 2373 - suggestion: Spell out 'GSP' on first use
  • Line 2382 - suggestion: Spell out 'CBDMA' on first use
  • Lines 2384, 2388 - warning: Prefer 'KB' over 'kB'.
  • Line 2391 - suggestion: Spell out 'QCOW' on first use
  • Line 2392 - suggestion: Spell out 'VDI' on first use
  • Line 2393 - suggestion: Spell out 'VHDX' on first use

content/GettingStarted/VersionNotes.md (357 issues)

  • Lines 46, 52, 56, 61, 67, 85, 86, 88, 95, 101, 125, 147, 158, 175, 240, 245, 251, 267, 287, 310, 377 - suggestion: Avoid contractions in formal writing
  • Lines 56, 58, 60, 63, 64, 66, 68, 70, 72, 74, 76, 77, 78, 79, 81, 83, 85, 110, 112, 115, 116, 121, 122, 124, 125, 130, 131, 132, 133, 134, 135, 136, 138, 139, 141, 142, 143, 147, 148, 149, 154, 155, 156, 171, 235, 264, 267, 268, 269, 279, 281, 287, 288 - suggestion: Spell out 'NAS' on first use
  • Line 57 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Line 57 - suggestion: Spell out 'TLS' on first use
  • Lines 61, 63, 80, 82, 84, 92, 101, 104, 110, 129, 147, 150, 172, 230, 242, 249, 251, 252, 264, 286, 294, 299, 301, 302, 304, 307, 308, 310, 311, 312, 369 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 63 - suggestion: Spell out 'CORE' on first use
  • Line 63 - suggestion: Spell out 'BIOS' on first use
  • Lines 64, 141, 142, 248, 251 - suggestion: Spell out 'SMB' on first use
  • Line 73 - warning: Prefer 'KB' over 'kB'.
  • Lines 73, 78 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 80 - suggestion: Spell out 'QED' on first use
  • Line 80 - suggestion: Spell out 'RAW' on first use
  • Line 80 - suggestion: Spell out 'VDI' on first use
  • Line 80 - suggestion: Spell out 'VHDX' on first use
  • Line 80 - suggestion: Spell out 'VMDK' on first use
  • Lines 85, 141 - suggestion: Spell out 'ACL' on first use
  • Line 85 - warning: Remove 'potentially' if it's not important to the meaning of the statement.
  • Line 86 - suggestion: Spell out 'PGP' on first use
  • Lines 92, 101, 158 - suggestion: Spell out 'BETA' on first use
  • Lines 92, 101, 107, 158 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Lines 104, 226, 307, 311, 312 - suggestion: Keep sentences under 30 words
  • Line 105 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 115 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 117 - suggestion: Spell out 'CSR' on first use
  • Lines 119, 132 - suggestion: Verify your use of 'Allows' with the A-Z word list.
  • Line 119 - suggestion: Spell out 'ACME' on first use
  • Line 119 - suggestion: Spell out 'DNS' on first use
  • Lines 125, 129, 230, 286, 287, 294, 299, 310, 311, 312 - suggestion: Spell out 'GPU' on first use
  • Line 130 - suggestion: Spell out 'FTP' on first use
  • Lines 135, 138, 252, 269 - suggestion: Spell out 'ZFS' on first use
  • Line 136 - suggestion: Spell out 'DHCP' on first use
  • Lines 138, 269 - suggestion: Spell out 'ARC' on first use
  • Lines 143, 235 - suggestion: Spell out 'IDMAP' on first use
  • Line 143 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 144, 236 - suggestion: Spell out 'RID' on first use
  • Line 146 - suggestion: Spell out 'JSON' on first use
  • Line 146 - suggestion: Spell out 'RPC' on first use
  • Line 147 - suggestion: Spell out 'REST' on first use
  • Lines 150, 151, 242 - suggestion: Spell out 'SMART' on first use
  • Line 153 - suggestion: Spell out 'SCSI' on first use
  • Line 153 - suggestion: Spell out 'SAS' on first use
  • Line 226 - warning: Use first person (such as 'My') sparingly.
  • Line 235 - error: Don't use 'Backend'. See the A-Z word list for details.
  • Line 259 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 273 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.
  • Line 294 - suggestion: 'NVIDIA GPU Support' should use sentence-style capitalization.
  • Line 294 - warning: Avoid using acronyms in a title or heading.
  • Lines 301, 307 - suggestion: Spell out 'GTX' on first use
  • Lines 301, 302 - suggestion: Spell out 'RTX' on first use
  • Lines 302, 308 - suggestion: Spell out 'GSP' on first use
  • Line 312 - suggestion: Spell out 'IPMI' on first use
  • Line 360 - suggestion: Use Title Case for headings

content/SCALETutorials/Storage/ManagePoolsScale.md (265 issues)

  • Lines 20, 67, 149, 165, 244, 265 - suggestion: Keep sentences under 30 words
  • Lines 28, 32, 36, 37, 39 - suggestion: Spell out 'TRIM' on first use
  • Lines 37, 65, 118, 120, 134, 138, 139, 142, 143, 145, 149, 156, 159, 163, 171, 175, 176, 196, 197, 200, 262, 263, 290, 329, 332, 342 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 37, 63, 65, 99, 103, 106, 107, 128, 138, 139, 142, 147, 157, 165, 167, 206, 207, 208, 209, 235, 254, 263, 265, 290, 292, 300, 332, 335, 338, 340, 342 - suggestion: Avoid contractions in formal writing
  • Line 37 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 39, 65, 143, 176, 196, 205, 296, 336, 347 - suggestion: Spell out 'ZFS' on first use
  • Line 74 - warning: Remove 'nearly' if it's not important to the meaning of the statement.
  • Line 86 - suggestion: Verify your use of 'alert' with the A-Z word list.
  • Lines 118, 128, 129, 130, 131, 133, 134, 138, 139, 142, 163, 179, 184, 197, 200, 207, 208, 209, 213, 215, 262, 263, 265, 290, 310, 329, 332, 340, 342, 344, 348, 351 - suggestion: Spell out 'VDEV' on first use
  • Line 120 - suggestion: Spell out 'SED' on first use
  • Lines 122, 265 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 128, 138, 142, 143, 145, 149, 156, 159, 163, 171, 175, 176, 179, 338, 342 - suggestion: Spell out 'RAIDZ' on first use
  • Lines 139, 207, 208 - suggestion: Spell out 'RAID' on first use
  • Lines 142, 313 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 143, 272 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 151 - suggestion: Verify your use of 'accessible' with the A-Z word list.
  • Line 168 - warning: Remove 'naturally' if it's not important to the meaning of the statement.
  • Line 175 - warning: Avoid using 'Salter's'
  • Line 209 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 209 - suggestion: Verify your use of 'ensure' with the A-Z word list.
  • Lines 248, 348 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Lines 267, 271 - suggestion: Spell out 'DDT' on first use
  • Line 329 - suggestion: Spell out 'SLOG' on first use
  • Line 342 - warning: Remove 'generally' if it's not important to the meaning of the statement.

static/llms.txt (179 issues)

  • Lines 3, 41, 47, 72, 73, 74, 81, 94, 99, 101, 105, 109, 113, 117, 120, 126, 130, 132, 135, 144, 159, 174, 192, 196, 200, 204, 208, 212, 214, 218 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 3 - suggestion: Spell out 'NAS' on first use
  • Lines 5, 27 - suggestion: Keep sentences under 30 words
  • Lines 7, 10, 11, 12, 15, 16, 19, 20, 21, 22, 23, 25, 29, 56, 57, 58, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73, 74, 75, 76, 79, 80, 81, 82, 85, 86, 91, 92, 93, 94, 95, 98, 99, 100, 101, 104, 105, 108, 109, 112, 113, 116, 117, 120, 121, 122, 125, 126, 129, 130, 131, 132, 135, 140, 143, 144, 147, 148, 149, 150, 155, 158, 159, 162, 163, 164, 165, 170, 173, 174, 177, 178, 179, 180, 185, 186, 187, 188, 191, 192, 195, 196, 199, 200, 203, 204, 207, 208, 211, 212, 213, 214, 217, 218, 222 - suggestion: Avoid contractions in formal writing
  • Lines 15, 16, 25, 33, 36, 41, 45, 47, 94 - suggestion: Spell out 'CORE' on first use
  • Lines 25, 32, 35, 46, 47 - suggestion: Spell out 'SCALE' on first use
  • Line 42 - warning: Avoid using 'version's'
  • Line 72 - suggestion: Spell out 'ZFS' on first use
  • Line 74 - suggestion: Spell out 'ACL' on first use

content/SCALEUIReference/Storage/_index.md (91 issues)

  • Lines 22, 254, 278 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 44, 104, 250, 258 - suggestion: Spell out 'ZFS' on first use
  • Lines 44, 69, 104, 153, 162, 301 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 64, 69, 101, 110, 114, 120, 135, 145, 202, 230, 236, 239, 240, 255, 265, 276 - suggestion: Avoid contractions in formal writing
  • Line 69 - suggestion: Spell out 'SMB' on first use
  • Lines 153, 154, 162, 202, 211, 278 - suggestion: Spell out 'VDEV' on first use
  • Line 154 - suggestion: Spell out 'RAID' on first use
  • Line 162 - suggestion: Keep sentences under 30 words
  • Line 174 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Lines 198, 254, 258 - suggestion: Spell out 'TRIM' on first use
  • Line 222 - suggestion: Verify your use of 'alert' with the A-Z word list.
  • Line 225 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 262, 265, 270, 283 - suggestion: Spell out 'DDT' on first use
  • Line 301 - suggestion: Spell out 'SAS' on first use
  • Line 301 - suggestion: Spell out 'SATA' on first use
  • Line 318 - warning: Remove 'nearly' if it's not important to the meaning of the statement.

CSV-TABLE-SETUP.md (61 issues)

  • Lines 5, 62, 65, 187, 193, 199, 209, 211, 226 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 5, 10, 65, 117, 128, 174, 187, 205, 209, 211 - suggestion: Spell out 'CSV' on first use
  • Lines 5, 103, 107, 183, 199, 223 - suggestion: Avoid contractions in formal writing
  • Line 5 - warning: Avoid using 'Here's'
  • Line 57 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Line 57 - suggestion: Spell out 'BETA' on first use
  • Lines 62, 116, 127, 128, 174, 187, 221, 226 - suggestion: Spell out 'JIRA' on first use
  • Lines 90, 103 - warning: Avoid using 'will'
  • Line 107 - warning: Avoid using 'What's'
  • Line 186 - suggestion: Use Title Case for headings
  • Line 193 - warning: Avoid using 'site's'
  • Lines 193, 199 - suggestion: Spell out 'CSS' on first use
  • Lines 205, 211 - suggestion: Verify your use of 'Ensure' with the A-Z word list.
  • Line 211 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 221 - suggestion: Verify your use of 'sample' with the A-Z word list.

release-summary/TrueNAS-SCALE-25.10-BETA.1.release-notes.txt (28 issues)

  • Lines 1, 12, 17 - suggestion: Keep sentences under 30 words
  • Line 2 - suggestion: Spell out 'BETA' on first use
  • Line 2 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Lines 2, 3 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 6 - suggestion: Spell out 'IDMAP' on first use
  • Lines 8, 9, 15, 17 - suggestion: Avoid contractions in formal writing
  • Lines 12, 13 - suggestion: Spell out 'WIP' on first use
  • Line 15 - suggestion: Spell out 'GPU' on first use
  • Line 15 - error: 'XX' is repeated!

static/includes/25.10FeatureList.md (27 issues)

  • Lines 7, 32 - suggestion: Keep sentences under 30 words
  • Lines 12, 13 - suggestion: Spell out 'RDMA' on first use
  • Lines 13, 14, 18, 21, 26, 27, 28, 32 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 13 - suggestion: Avoid contractions in formal writing
  • Line 14 - suggestion: Spell out 'DHCP' on first use
  • Line 26 - warning: Avoid using 'NVIDIA's'
  • Lines 26, 27, 28 - suggestion: Spell out 'GPU' on first use
  • Line 32 - suggestion: Spell out 'ZFS' on first use

release-summary/TrueNAS-SCALE-25.10-RC.1.release-notes.txt (26 issues)

  • Lines 1, 14, 18 - suggestion: Keep sentences under 30 words
  • Lines 3, 15 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 8 - suggestion: Spell out 'IDMAP' on first use
  • Lines 9, 12 - suggestion: Spell out 'SMB' on first use
  • Lines 9, 15 - suggestion: Try to simplify this sentence.
  • Lines 10, 15, 18 - suggestion: Avoid contractions in formal writing
  • Line 10 - suggestion: Spell out 'TLS' on first use
  • Line 15 - suggestion: Spell out 'GPU' on first use

release-summary/release-summary-template.md (5 issues)

  • Lines 4, 5 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Line 5 - suggestion: Spell out 'BETA' on first use
  • Line 5 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands

content/_index.md (4 issues)

  • Line 39 - suggestion: Spell out 'CORE' on first use
  • Lines 39, 49 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands

🔧 To fix: Review the issues above and update your documentation accordingly.

@github-actions GitHub Actions

This comment was marked as duplicate.

Sign in to view
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 8, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 1589 issues found in changed files - 72 errors, 32 warnings, 1485 suggestions

Changed files with issues:

words-to-ignore.txt (536 issues)

  • Line 1 - suggestion: Keep sentences under 30 words
  • Line 5 - suggestion: Spell out 'NAS' on first use
  • Line 10 - suggestion: Spell out 'WSL' on first use
  • Line 29 - suggestion: Spell out 'ALUA' on first use
  • Line 30 - suggestion: Spell out 'MTU' on first use
  • Line 34 - suggestion: Spell out 'LUN' on first use
  • Line 36 - suggestion: Spell out 'SATA' on first use
  • Line 37 - suggestion: Spell out 'OSI' on first use
  • Line 38 - suggestion: Spell out 'PDU' on first use
  • Line 50 - suggestion: Spell out 'AHIC' on first use
  • Line 52 - suggestion: Spell out 'VNC' on first use
  • Lines 53, 54 - suggestion: Spell out 'UEFI' on first use
  • Line 60 - suggestion: Spell out 'SDLC' on first use
  • Line 62 - suggestion: Spell out 'VNET' on first use
  • Line 64 - suggestion: Spell out 'VMFS' on first use
  • Line 65 - error: 'Virtualized' is repeated!
  • Line 71 - suggestion: Spell out 'DAC' on first use
  • Lines 72, 73 - suggestion: Spell out 'QSFP' on first use
  • Line 75 - suggestion: Spell out 'SSD' on first use
  • Line 77 - suggestion: Spell out 'SED' on first use
  • Line 85 - suggestion: Spell out 'TBD' on first use
  • Line 87 - error: 'ZFS' is repeated!
  • Line 88 - suggestion: Spell out 'ZFS' on first use
  • Line 93 - suggestion: Spell out 'SMB' on first use
  • Line 94 - suggestion: Spell out 'AAPL' on first use
  • Line 97 - suggestion: Spell out 'IPMI' on first use
  • Line 98 - suggestion: Spell out 'VLAN' on first use
  • Line 116 - error: 'MinIO' is repeated!
  • Line 127 - suggestion: Spell out 'FSCTL' on first use
  • Line 129 - suggestion: Spell out 'ACL' on first use
  • Line 134 - error: 'RX' is repeated!
  • Line 143 - suggestion: Spell out 'CVE' on first use
  • Line 148 - suggestion: Spell out 'NIS' on first use
  • Line 150 - suggestion: Spell out 'HWPMC' on first use
  • Line 162 - suggestion: Spell out 'MCA' on first use
  • Line 163 - suggestion: Spell out 'APEI' on first use
  • Line 164 - suggestion: Spell out 'EPCT' on first use
  • Line 165 - suggestion: Spell out 'NVM' on first use
  • Line 174 - suggestion: Spell out 'RTL' on first use
  • Line 178 - suggestion: Spell out 'NIC' on first use
  • Line 179 - suggestion: Spell out 'JIRA' on first use
  • Lines 188, 505, 764, 1983, 2105 - suggestion: Avoid contractions in formal writing
  • Line 204 - suggestion: Spell out 'NFS' on first use
  • Line 204 - error: 'nfs' is repeated!
  • Line 222 - error: 'GELI' is repeated!
  • Line 223 - suggestion: Spell out 'GELI' on first use
  • Line 224 - suggestion: Spell out 'CSR' on first use
  • Line 229 - suggestion: Spell out 'RSFSR' on first use
  • Lines 232, 233 - suggestion: Spell out 'DHCP' on first use
  • Line 234 - suggestion: Spell out 'AFP' on first use
  • Line 241 - error: 'tunables' is repeated!
  • Line 246 - suggestion: Spell out 'CLI' on first use
  • Line 268 - suggestion: Spell out 'SME' on first use
  • Line 269 - suggestion: Spell out 'ECC' on first use
  • Line 282 - suggestion: Spell out 'BSG' on first use
  • Line 283 - suggestion: Spell out 'FBSG' on first use
  • Line 294 - suggestion: Spell out 'POSIX' on first use
  • Line 295 - suggestion: Spell out 'CIFS' on first use
  • Line 312 - suggestion: Spell out 'IEC' on first use
  • Lines 329, 411 - suggestion: Spell out 'ZIL' on first use
  • Lines 337, 2146 - suggestion: Spell out 'VPN' on first use
  • Line 340 - suggestion: Spell out 'DNS' on first use
  • Line 342 - error: 'hostname' is repeated!
  • Line 346 - suggestion: Spell out 'LDAP' on first use
  • Line 347 - suggestion: Spell out 'DDNS' on first use
  • Line 349 - suggestion: Spell out 'LLDP' on first use
  • Line 350 - suggestion: Spell out 'NDS' on first use
  • Line 351 - suggestion: Spell out 'NTP' on first use
  • Line 354 - suggestion: Spell out 'KMIP' on first use
  • Line 358 - suggestion: Spell out 'AFS' on first use
  • Line 361 - suggestion: Spell out 'AHCI' on first use
  • Line 362 - suggestion: Spell out 'ATA' on first use
  • Line 367 - suggestion: Spell out 'KVM' on first use
  • Line 368 - suggestion: Spell out 'MBR' on first use
  • Line 369 - suggestion: Spell out 'CSM' on first use
  • Line 382 - suggestion: Spell out 'SFTP' on first use
  • Line 383 - suggestion: Spell out 'UDP' on first use
  • Line 385 - suggestion: Spell out 'SNMP' on first use
  • Line 387 - suggestion: Spell out 'TLS' on first use
  • Line 405 - suggestion: Spell out 'MLC' on first use
  • Line 408 - suggestion: Spell out 'SDC' on first use
  • Line 410 - suggestion: Spell out 'TXG' on first use
  • Line 412 - suggestion: Spell out 'IOPS' on first use
  • Line 414 - suggestion: Spell out 'VDEV' on first use
  • Line 425 - suggestion: Spell out 'VSS' on first use
  • Line 427 - suggestion: Spell out 'OSX' on first use
  • Line 428 - error: 'deduplication' is repeated!
  • Line 435 - error: 'Filesystems' is repeated!
  • Line 445 - suggestion: Spell out 'EVO' on first use
  • Line 457 - error: 'sha' is repeated!
  • Line 457 - suggestion: Spell out 'SHA' on first use
  • Line 459 - suggestion: Spell out 'NVRAM' on first use
  • Line 464 - suggestion: Spell out 'JBOD' on first use
  • Line 465 - suggestion: Spell out 'MTTDL' on first use
  • Line 467 - error: 'Resilvering' is repeated!
  • Lines 479, 546 - suggestion: Spell out 'DFS' on first use
  • Line 494 - suggestion: Spell out 'PCI' on first use
  • Line 496 - suggestion: Spell out 'EDK' on first use
  • Line 497 - suggestion: Spell out 'INIT' on first use
  • Line 498 - suggestion: Spell out 'ALLOC' on first use
  • Line 517 - suggestion: Spell out 'TNS' on first use
  • Line 518 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 525 - suggestion: Spell out 'QEMU' on first use
  • Line 530 - suggestion: Spell out 'ESC' on first use
  • Line 577 - suggestion: Spell out 'DMA' on first use
  • Line 595 - suggestion: Spell out 'SPN' on first use
  • Line 597 - suggestion: Spell out 'EZFS' on first use
  • Line 598 - suggestion: Spell out 'NOCAP' on first use
  • Line 614 - suggestion: Spell out 'EUI' on first use
  • Line 615 - suggestion: Spell out 'IQN' on first use
  • Line 620 - suggestion: Spell out 'SFP' on first use
  • Line 621 - suggestion: Spell out 'LSO' on first use
  • Line 622 - suggestion: Spell out 'LRO' on first use
  • Line 627 - suggestion: Spell out 'PSU' on first use
  • Line 629 - suggestion: Spell out 'LACP' on first use
  • Line 633 - suggestion: Spell out 'BMC' on first use
  • Line 635 - suggestion: Spell out 'EPYC' on first use
  • Lines 638, 710 - suggestion: Spell out 'AES' on first use
  • Lines 642, 644, 645 - suggestion: Spell out 'SAS' on first use
  • Line 646 - suggestion: Spell out 'STP' on first use
  • Line 652 - suggestion: Spell out 'BBU' on first use
  • Line 653 - suggestion: Spell out 'HBA' on first use
  • Line 657 - suggestion: Spell out 'LSI' on first use
  • Line 662 - suggestion: Spell out 'CRC' on first use
  • Line 663 - suggestion: Spell out 'UDMA' on first use
  • Line 666 - suggestion: Spell out 'DIF' on first use
  • Line 676 - error: 'multipath' is repeated!
  • Line 681 - suggestion: Spell out 'PMR' on first use
  • Line 682 - suggestion: Spell out 'CMR' on first use
  • Line 690 - suggestion: Spell out 'LZJB' on first use
  • Line 692 - suggestion: Spell out 'ZLE' on first use
  • Line 694 - suggestion: Spell out 'ZSTD' on first use
  • Line 706 - suggestion: Spell out 'TFTP' on first use
  • Line 717 - suggestion: Spell out 'MMC' on first use
  • Line 718 - suggestion: Spell out 'UTF' on first use
  • Line 733 - suggestion: Spell out 'FXP' on first use
  • Line 735 - suggestion: Spell out 'PASV' on first use
  • Line 737 - suggestion: Spell out 'FQDN' on first use
  • Line 738 - suggestion: Spell out 'PEM' on first use
  • Line 742 - error: 'IDENT' is repeated!
  • Line 743 - suggestion: Spell out 'IDENT' on first use
  • Line 748 - error: 'CheckIP' is repeated!
  • Line 761 - suggestion: Spell out 'SMTP' on first use
  • Line 763 - suggestion: Spell out 'FIPS' on first use
  • Line 784 - error: 'VMM' is repeated!
  • Line 785 - suggestion: Spell out 'VMM' on first use
  • Line 793 - suggestion: Spell out 'IPC' on first use
  • Line 797 - suggestion: Spell out 'SYSV' on first use
  • Line 803 - error: 'Chmod' is repeated!
  • Line 817 - error: 'autoconfigure' is repeated!
  • Line 820 - suggestion: Spell out 'BPF' on first use
  • Line 821 - suggestion: Spell out 'SLAAC' on first use
  • Lines 827, 2056 - suggestion: Spell out 'UUID' on first use
  • Line 831 - error: 'VDevs' is repeated!
  • Line 836 - suggestion: Spell out 'PBKDF' on first use
  • Line 849 - suggestion: Spell out 'PTR' on first use
  • Line 850 - suggestion: Spell out 'CTDB' on first use
  • Line 870 - suggestion: Spell out 'RBAC' on first use
  • Line 871 - warning: Avoid using 'TrueCommand's'
  • Line 872 - suggestion: Spell out 'CSV' on first use
  • Line 891 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 898 - suggestion: Spell out 'SAML' on first use
  • Line 925 - suggestion: Spell out 'CORS' on first use
  • Line 930 - suggestion: Spell out 'GORM' on first use
  • Line 933 - error: 'Ux' is repeated!
  • Line 938 - suggestion: Spell out 'SNI' on first use
  • Line 944 - warning: Avoid using 'API's'
  • Line 955 - error: 'Hyperconverged' is repeated!
  • Line 959 - suggestion: Spell out 'HCI' on first use
  • Line 1001 - suggestion: Spell out 'BTIME' on first use
  • Line 1025 - suggestion: Spell out 'NTB' on first use
  • Line 1033 - suggestion: Spell out 'KDC' on first use
  • Line 1040 - suggestion: Spell out 'RSS' on first use
  • Line 1044 - suggestion: Spell out 'NDP' on first use
  • Line 1055 - suggestion: Spell out 'STIG' on first use
  • Line 1064 - suggestion: Spell out 'OOB' on first use
  • Line 1069 - suggestion: Spell out 'OTP' on first use
  • Line 1075 - suggestion: Spell out 'HPE' on first use
  • Line 1121 - suggestion: Spell out 'GIDS' on first use
  • Line 1122 - suggestion: Spell out 'UIDS' on first use
  • Line 1132 - suggestion: Spell out 'PID' on first use
  • Line 1133 - suggestion: Spell out 'VID' on first use
  • Lines 1151, 2061, 2135 - suggestion: Spell out 'CMD' on first use
  • Line 1151 - suggestion: Spell out 'LINE' on first use
  • Line 1166 - warning: Prefer 'Gbps' over 'GBps'.
  • Lines 1167, 1168 - suggestion: Spell out 'IDP' on first use
  • Line 1217 - suggestion: Spell out 'SMR' on first use
  • Line 1218 - suggestion: Spell out 'ACPI' on first use
  • Line 1249 - suggestion: Spell out 'HSTS' on first use
  • Line 1259 - suggestion: Spell out 'CRIT' on first use
  • Line 1261 - suggestion: Spell out 'AMD' on first use
  • Line 1262 - suggestion: Spell out 'SVM' on first use
  • Line 1335 - suggestion: Spell out 'IXGBE' on first use
  • Line 1342 - suggestion: Spell out 'ECR' on first use
  • Line 1345 - suggestion: Spell out 'ASYNC' on first use
  • Line 1346 - suggestion: Spell out 'IOSQE' on first use
  • Line 1350 - error: 'MicroServer' is repeated!
  • Line 1355 - suggestion: Spell out 'IBS' on first use
  • Line 1369 - error: 'Rebalancing' is repeated!
  • Line 1383 - suggestion: Spell out 'WIP' on first use
  • Line 1387 - suggestion: Spell out 'TPC' on first use
  • Line 1441 - suggestion: Spell out 'SASL' on first use
  • Line 1459 - error: 'Webhook' is repeated!
  • Line 1463 - error: 'MatterMost' is repeated!
  • Line 1469 - error: 'ARN' is repeated!
  • Line 1470 - suggestion: Spell out 'ARN' on first use
  • Line 1471 - suggestion: Spell out 'SNS' on first use
  • Line 1478 - suggestion: Spell out 'MNMD' on first use
  • Line 1480 - suggestion: Spell out 'GMAIL' on first use
  • Line 1480 - error: 'gmail' is repeated!
  • Line 1483 - error: 'oauth' is repeated!
  • Line 1485 - suggestion: Spell out 'OAUTH' on first use
  • Line 1506 - suggestion: Spell out 'DTYP' on first use
  • Line 1517 - error: 'FSeriesStencil' is repeated!
  • Line 1536 - error: 'mydata' is repeated!
  • Lines 1546, 1606 - warning: Prefer 'GB' over 'Gb'.
  • Line 1567 - suggestion: Spell out 'OOBM' on first use
  • Line 1572 - suggestion: Spell out 'XOOBM' on first use
  • Line 1590 - error: 'NVDIMMUpdates' is repeated!
  • Line 1615 - error: 'gb' is repeated!
  • Line 1616 - warning: Prefer 'GB' over 'gb'.
  • Line 1651 - suggestion: Spell out 'HPC' on first use
  • Line 1668 - suggestion: Spell out 'BSOV' on first use
  • Line 1669 - error: 'misconfiguration' is repeated!
  • Line 1679 - error: 'discoverability' is repeated!
  • Line 1692 - suggestion: Spell out 'LXC' on first use
  • Line 1709 - suggestion: Spell out 'PUM' on first use
  • Line 1710 - suggestion: Spell out 'PRG' on first use
  • Line 1720 - suggestion: Spell out 'DACL' on first use
  • Line 1721 - suggestion: Spell out 'SACL' on first use
  • Line 1745 - suggestion: Spell out 'CSI' on first use
  • Line 1779 - suggestion: Spell out 'TUI' on first use
  • Line 1812 - suggestion: Spell out 'VLANS' on first use
  • Line 1827 - suggestion: Spell out 'NUMA' on first use
  • Lines 1834, 1849 - suggestion: Spell out 'MSR' on first use
  • Line 1836 - warning: Avoid using 'GPU's'
  • Line 1836 - suggestion: Spell out 'GPU' on first use
  • Line 1852 - suggestion: Spell out 'ROM' on first use
  • Line 1891 - error: 'hseries' is repeated!
  • Line 1896 - error: 'hseriesstencil' is repeated!
  • Line 1899 - error: 'hseriessov' is repeated!
  • Line 1901 - error: 'minirsov' is repeated!
  • Line 1915 - suggestion: Spell out 'NPUM' on first use
  • Line 1915 - error: 'npum' is repeated!
  • Line 1917 - error: 'nstencil' is repeated!
  • Line 1922 - suggestion: Spell out 'IANA' on first use
  • Line 1927 - suggestion: Spell out 'IEE' on first use
  • Line 1928 - error: 'ipsec' is repeated!
  • Line 1936 - suggestion: Spell out 'TTL' on first use
  • Line 1937 - suggestion: Spell out 'PIM' on first use
  • Line 1938 - error: 'stateful' is repeated!
  • Line 1943 - warning: 'publicly-accessible' doesn't need a hyphen.
  • Line 1943 - suggestion: Verify your use of 'accessible' with the A-Z word list.
  • Line 1944 - error: 'Unicast' is repeated!
  • Line 1956 - suggestion: Spell out 'NAA' on first use
  • Line 1958 - suggestion: Spell out 'FFF' on first use
  • Line 1965 - error: 'TruenasApps' is repeated!
  • Line 2030 - suggestion: Spell out 'TTY' on first use
  • Line 2059 - suggestion: Spell out 'ENV' on first use
  • Line 2061 - suggestion: Spell out 'SHELL' on first use
  • Line 2080 - suggestion: Spell out 'CHOWN' on first use
  • Line 2142 - suggestion: Spell out 'FSA' on first use
  • Line 2143 - error: 'zerotier' is repeated!
  • Line 2145 - error: 'VPN' is repeated!
  • Line 2147 - error: 'tailscale' is repeated!
  • Line 2158 - suggestion: Spell out 'SOV' on first use
  • Line 2166 - error: 'ddt' is repeated!
  • Line 2166 - suggestion: Spell out 'DDT' on first use
  • Line 2168 - error: 'ddts' is repeated!
  • Line 2170 - suggestion: Spell out 'ZAP' on first use
  • Line 2171 - suggestion: Spell out 'ARC' on first use
  • Line 2172 - error: 'dbit' is repeated!
  • Line 2174 - error: 'ZFSDeduplication' is repeated!
  • Line 2176 - error: 'ZFSPrimer' is repeated!
  • Line 2178 - error: 'ZILandSLOG' is repeated!
  • Line 2233 - suggestion: Spell out 'TPM' on first use
  • Line 2264 - suggestion: Spell out 'BMPUM' on first use
  • Line 2272 - error: 'iXVolumes' is repeated!
  • Line 2291 - suggestion: Spell out 'BLK' on first use
  • Line 2292 - suggestion: Spell out 'SCSI' on first use
  • Line 2303 - error: 'Cksum' is repeated!
  • Line 2372 - suggestion: Spell out 'GTX' on first use
  • Line 2373 - suggestion: Spell out 'RTX' on first use
  • Line 2374 - suggestion: Spell out 'GSP' on first use
  • Line 2383 - suggestion: Spell out 'CBDMA' on first use
  • Lines 2385, 2389 - warning: Prefer 'KB' over 'kB'.
  • Line 2392 - suggestion: Spell out 'QCOW' on first use
  • Line 2393 - suggestion: Spell out 'VDI' on first use
  • Line 2394 - suggestion: Spell out 'VHDX' on first use

content/GettingStarted/VersionNotes.md (364 issues)

  • Lines 46, 52, 56, 61, 67, 85, 86, 88, 95, 101, 125, 147, 158, 172, 178, 243, 248, 254, 270, 290, 313, 380 - suggestion: Avoid contractions in formal writing
  • Lines 56, 58, 60, 63, 64, 66, 68, 70, 72, 74, 76, 77, 78, 79, 81, 83, 85, 110, 112, 115, 116, 121, 122, 124, 125, 130, 131, 132, 133, 134, 135, 136, 138, 139, 141, 142, 143, 147, 148, 149, 154, 155, 156, 171, 174, 238, 267, 270, 271, 272, 282, 284, 290, 291 - suggestion: Spell out 'NAS' on first use
  • Line 57 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Line 57 - suggestion: Spell out 'TLS' on first use
  • Lines 61, 63, 80, 82, 84, 92, 101, 104, 110, 129, 147, 150, 172, 175, 233, 245, 252, 254, 255, 267, 289, 297, 302, 304, 305, 307, 310, 311, 313, 314, 315, 372 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 63 - suggestion: Spell out 'CORE' on first use
  • Line 63 - suggestion: Spell out 'BIOS' on first use
  • Lines 64, 141, 142, 251, 254 - suggestion: Spell out 'SMB' on first use
  • Line 71 - suggestion: Spell out 'WIP' on first use
  • Line 73 - warning: Prefer 'KB' over 'kB'.
  • Lines 73, 78 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 80 - suggestion: Spell out 'QED' on first use
  • Line 80 - suggestion: Spell out 'RAW' on first use
  • Line 80 - suggestion: Spell out 'VDI' on first use
  • Line 80 - suggestion: Spell out 'VHDX' on first use
  • Line 80 - suggestion: Spell out 'VMDK' on first use
  • Lines 85, 141 - suggestion: Spell out 'ACL' on first use
  • Line 85 - warning: Remove 'potentially' if it's not important to the meaning of the statement.
  • Line 86 - suggestion: Spell out 'PGP' on first use
  • Lines 92, 101, 107, 158 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Lines 92, 101, 158 - suggestion: Spell out 'BETA' on first use
  • Lines 104, 229, 310, 314, 315 - suggestion: Keep sentences under 30 words
  • Line 105 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 115 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 119, 132 - suggestion: Verify your use of 'Allows' with the A-Z word list.
  • Line 119 - suggestion: Spell out 'ACME' on first use
  • Line 119 - suggestion: Spell out 'DNS' on first use
  • Lines 125, 129, 233, 289, 290, 297, 302, 313, 314, 315 - suggestion: Spell out 'GPU' on first use
  • Line 130 - suggestion: Spell out 'FTP' on first use
  • Lines 135, 138, 172, 255, 272 - suggestion: Spell out 'ZFS' on first use
  • Line 136 - suggestion: Spell out 'DHCP' on first use
  • Lines 138, 272 - suggestion: Spell out 'ARC' on first use
  • Lines 143, 238 - suggestion: Spell out 'IDMAP' on first use
  • Line 143 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 144, 239 - suggestion: Spell out 'RID' on first use
  • Line 146 - suggestion: Spell out 'JSON' on first use
  • Line 146 - suggestion: Spell out 'RPC' on first use
  • Line 147 - suggestion: Spell out 'REST' on first use
  • Lines 150, 151, 245 - suggestion: Spell out 'SMART' on first use
  • Line 153 - suggestion: Spell out 'SCSI' on first use
  • Line 153 - suggestion: Spell out 'SAS' on first use
  • Line 229 - warning: Use first person (such as 'My') sparingly.
  • Line 238 - error: Don't use 'Backend'. See the A-Z word list for details.
  • Line 262 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 276 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.
  • Line 297 - suggestion: 'NVIDIA GPU Support' should use sentence-style capitalization.
  • Line 297 - warning: Avoid using acronyms in a title or heading.
  • Lines 304, 310 - suggestion: Spell out 'GTX' on first use
  • Lines 304, 305 - suggestion: Spell out 'RTX' on first use
  • Lines 305, 311 - suggestion: Spell out 'GSP' on first use
  • Line 315 - suggestion: Spell out 'IPMI' on first use
  • Line 363 - suggestion: Use Title Case for headings

content/SCALETutorials/Storage/ManagePoolsScale.md (268 issues)

  • Lines 20, 67, 161, 177, 256, 277 - suggestion: Keep sentences under 30 words
  • Lines 28, 32, 36, 37, 39 - suggestion: Spell out 'TRIM' on first use
  • Lines 37, 65, 118, 120, 134, 150, 151, 154, 155, 157, 161, 168, 171, 175, 183, 187, 188, 208, 209, 212, 274, 275, 302, 341, 344, 354 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 37, 63, 65, 99, 103, 106, 107, 128, 136, 150, 151, 154, 159, 169, 177, 179, 218, 219, 220, 221, 247, 266, 275, 277, 302, 304, 312, 344, 347, 350, 352, 354 - suggestion: Avoid contractions in formal writing
  • Line 37 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 39, 65, 155, 188, 208, 217, 308, 348, 359 - suggestion: Spell out 'ZFS' on first use
  • Line 74 - warning: Remove 'nearly' if it's not important to the meaning of the statement.
  • Line 86 - suggestion: Verify your use of 'alert' with the A-Z word list.
  • Lines 118, 128, 129, 130, 131, 133, 134, 150, 151, 154, 175, 191, 196, 209, 212, 219, 220, 221, 225, 227, 274, 275, 277, 302, 322, 341, 344, 352, 354, 356, 360, 363 - suggestion: Spell out 'VDEV' on first use
  • Line 120 - suggestion: Spell out 'SED' on first use
  • Lines 122, 277 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 128, 150, 154, 155, 157, 161, 168, 171, 175, 183, 187, 188, 191, 350, 354 - suggestion: Spell out 'RAIDZ' on first use
  • Lines 136, 142, 260, 360 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Lines 151, 219, 220 - suggestion: Spell out 'RAID' on first use
  • Lines 154, 325 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 155, 284 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 163 - suggestion: Verify your use of 'accessible' with the A-Z word list.
  • Line 180 - warning: Remove 'naturally' if it's not important to the meaning of the statement.
  • Line 187 - warning: Avoid using 'Salter's'
  • Line 221 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 221 - suggestion: Verify your use of 'ensure' with the A-Z word list.
  • Lines 279, 283 - suggestion: Spell out 'DDT' on first use
  • Line 341 - suggestion: Spell out 'SLOG' on first use
  • Line 354 - warning: Remove 'generally' if it's not important to the meaning of the statement.

static/llms.txt (179 issues)

  • Lines 3, 41, 47, 72, 73, 74, 81, 94, 99, 101, 105, 109, 113, 117, 120, 126, 130, 132, 135, 144, 159, 174, 192, 196, 200, 204, 208, 212, 214, 218 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 3 - suggestion: Spell out 'NAS' on first use
  • Lines 5, 27 - suggestion: Keep sentences under 30 words
  • Lines 7, 10, 11, 12, 15, 16, 19, 20, 21, 22, 23, 25, 29, 56, 57, 58, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73, 74, 75, 76, 79, 80, 81, 82, 85, 86, 91, 92, 93, 94, 95, 98, 99, 100, 101, 104, 105, 108, 109, 112, 113, 116, 117, 120, 121, 122, 125, 126, 129, 130, 131, 132, 135, 140, 143, 144, 147, 148, 149, 150, 155, 158, 159, 162, 163, 164, 165, 170, 173, 174, 177, 178, 179, 180, 185, 186, 187, 188, 191, 192, 195, 196, 199, 200, 203, 204, 207, 208, 211, 212, 213, 214, 217, 218, 222 - suggestion: Avoid contractions in formal writing
  • Lines 15, 16, 25, 33, 36, 41, 45, 47, 94 - suggestion: Spell out 'CORE' on first use
  • Lines 25, 32, 35, 46, 47 - suggestion: Spell out 'SCALE' on first use
  • Line 42 - warning: Avoid using 'version's'
  • Line 72 - suggestion: Spell out 'ZFS' on first use
  • Line 74 - suggestion: Spell out 'ACL' on first use

content/SCALEUIReference/Storage/_index.md (91 issues)

  • Lines 22, 254, 278 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 44, 69, 104, 153, 162, 301 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 44, 104, 250, 258 - suggestion: Spell out 'ZFS' on first use
  • Lines 64, 69, 101, 110, 114, 120, 135, 145, 202, 230, 236, 239, 240, 255, 265, 276 - suggestion: Avoid contractions in formal writing
  • Line 69 - suggestion: Spell out 'SMB' on first use
  • Lines 153, 154, 162, 202, 211, 278 - suggestion: Spell out 'VDEV' on first use
  • Line 154 - suggestion: Spell out 'RAID' on first use
  • Line 162 - suggestion: Keep sentences under 30 words
  • Line 174 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Lines 198, 254, 258 - suggestion: Spell out 'TRIM' on first use
  • Line 222 - suggestion: Verify your use of 'alert' with the A-Z word list.
  • Line 225 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 262, 265, 270, 283 - suggestion: Spell out 'DDT' on first use
  • Line 301 - suggestion: Spell out 'SAS' on first use
  • Line 301 - suggestion: Spell out 'SATA' on first use
  • Line 318 - warning: Remove 'nearly' if it's not important to the meaning of the statement.

CSV-TABLE-SETUP.md (61 issues)

  • Lines 5, 10, 65, 117, 128, 174, 187, 205, 209, 211 - suggestion: Spell out 'CSV' on first use
  • Lines 5, 62, 65, 187, 193, 199, 209, 211, 226 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 5, 103, 107, 183, 199, 223 - suggestion: Avoid contractions in formal writing
  • Line 5 - warning: Avoid using 'Here's'
  • Line 57 - suggestion: Spell out 'BETA' on first use
  • Line 57 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Lines 62, 116, 127, 128, 174, 187, 221, 226 - suggestion: Spell out 'JIRA' on first use
  • Lines 90, 103 - warning: Avoid using 'will'
  • Line 107 - warning: Avoid using 'What's'
  • Line 186 - suggestion: Use Title Case for headings
  • Line 193 - warning: Avoid using 'site's'
  • Lines 193, 199 - suggestion: Spell out 'CSS' on first use
  • Lines 205, 211 - suggestion: Verify your use of 'Ensure' with the A-Z word list.
  • Line 211 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 221 - suggestion: Verify your use of 'sample' with the A-Z word list.

release-summary/TrueNAS-SCALE-25.10-BETA.1.release-notes.txt (28 issues)

  • Lines 1, 12, 17 - suggestion: Keep sentences under 30 words
  • Lines 2, 3 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 2 - suggestion: Spell out 'BETA' on first use
  • Line 2 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Line 6 - suggestion: Spell out 'IDMAP' on first use
  • Lines 8, 9, 15, 17 - suggestion: Avoid contractions in formal writing
  • Lines 12, 13 - suggestion: Spell out 'WIP' on first use
  • Line 15 - suggestion: Spell out 'GPU' on first use
  • Line 15 - error: 'XX' is repeated!

static/includes/25.10FeatureList.md (27 issues)

  • Lines 7, 32 - suggestion: Keep sentences under 30 words
  • Lines 12, 13 - suggestion: Spell out 'RDMA' on first use
  • Lines 13, 14, 18, 21, 26, 27, 28, 32 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 13 - suggestion: Avoid contractions in formal writing
  • Line 14 - suggestion: Spell out 'DHCP' on first use
  • Line 26 - warning: Avoid using 'NVIDIA's'
  • Lines 26, 27, 28 - suggestion: Spell out 'GPU' on first use
  • Line 32 - suggestion: Spell out 'ZFS' on first use

release-summary/TrueNAS-SCALE-25.10-RC.1.release-notes.txt (26 issues)

  • Lines 1, 14, 18 - suggestion: Keep sentences under 30 words
  • Lines 3, 15 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 8 - suggestion: Spell out 'IDMAP' on first use
  • Lines 9, 12 - suggestion: Spell out 'SMB' on first use
  • Lines 9, 15 - suggestion: Try to simplify this sentence.
  • Lines 10, 15, 18 - suggestion: Avoid contractions in formal writing
  • Line 10 - suggestion: Spell out 'TLS' on first use
  • Line 15 - suggestion: Spell out 'GPU' on first use

release-summary/release-summary-template.md (5 issues)

  • Lines 4, 5 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Line 5 - suggestion: Spell out 'BETA' on first use
  • Line 5 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands

content/_index.md (4 issues)

  • Line 39 - suggestion: Spell out 'CORE' on first use
  • Lines 39, 49 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands

🔧 To fix: Review the issues above and update your documentation accordingly.

micjohnson777
micjohnson777 previously approved these changes Oct 9, 2025
View reviewed changes
@micjohnson777 micjohnson777 added the Technical Writer Review (MJ) A technical writer is reviewing the PR. label Oct 9, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 10, 2025 •
edited
Loading

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

📊 Summary: 1535 issues found in changed files - 71 errors, 32 warnings, 1432 suggestions

Changed files with issues:

words-to-ignore.txt (536 issues)

  • Line 1 - suggestion: Keep sentences under 30 words
  • Line 5 - suggestion: Spell out 'NAS' on first use
  • Line 10 - suggestion: Spell out 'WSL' on first use
  • Line 29 - suggestion: Spell out 'ALUA' on first use
  • Line 30 - suggestion: Spell out 'MTU' on first use
  • Line 34 - suggestion: Spell out 'LUN' on first use
  • Line 36 - suggestion: Spell out 'SATA' on first use
  • Line 37 - suggestion: Spell out 'OSI' on first use
  • Line 38 - suggestion: Spell out 'PDU' on first use
  • Line 50 - suggestion: Spell out 'AHIC' on first use
  • Line 52 - suggestion: Spell out 'VNC' on first use
  • Lines 53, 54 - suggestion: Spell out 'UEFI' on first use
  • Line 60 - suggestion: Spell out 'SDLC' on first use
  • Line 62 - suggestion: Spell out 'VNET' on first use
  • Line 64 - suggestion: Spell out 'VMFS' on first use
  • Line 65 - error: 'Virtualized' is repeated!
  • Line 71 - suggestion: Spell out 'DAC' on first use
  • Lines 72, 73 - suggestion: Spell out 'QSFP' on first use
  • Line 75 - suggestion: Spell out 'SSD' on first use
  • Line 77 - suggestion: Spell out 'SED' on first use
  • Line 85 - suggestion: Spell out 'TBD' on first use
  • Line 87 - error: 'ZFS' is repeated!
  • Line 88 - suggestion: Spell out 'ZFS' on first use
  • Line 93 - suggestion: Spell out 'SMB' on first use
  • Line 94 - suggestion: Spell out 'AAPL' on first use
  • Line 97 - suggestion: Spell out 'IPMI' on first use
  • Line 98 - suggestion: Spell out 'VLAN' on first use
  • Line 116 - error: 'MinIO' is repeated!
  • Line 127 - suggestion: Spell out 'FSCTL' on first use
  • Line 129 - suggestion: Spell out 'ACL' on first use
  • Line 134 - error: 'RX' is repeated!
  • Line 143 - suggestion: Spell out 'CVE' on first use
  • Line 148 - suggestion: Spell out 'NIS' on first use
  • Line 150 - suggestion: Spell out 'HWPMC' on first use
  • Line 162 - suggestion: Spell out 'MCA' on first use
  • Line 163 - suggestion: Spell out 'APEI' on first use
  • Line 164 - suggestion: Spell out 'EPCT' on first use
  • Line 165 - suggestion: Spell out 'NVM' on first use
  • Line 174 - suggestion: Spell out 'RTL' on first use
  • Line 178 - suggestion: Spell out 'NIC' on first use
  • Line 179 - suggestion: Spell out 'JIRA' on first use
  • Lines 188, 505, 764, 1983, 2105 - suggestion: Avoid contractions in formal writing
  • Line 204 - suggestion: Spell out 'NFS' on first use
  • Line 204 - error: 'nfs' is repeated!
  • Line 222 - error: 'GELI' is repeated!
  • Line 223 - suggestion: Spell out 'GELI' on first use
  • Line 224 - suggestion: Spell out 'CSR' on first use
  • Line 229 - suggestion: Spell out 'RSFSR' on first use
  • Lines 232, 233 - suggestion: Spell out 'DHCP' on first use
  • Line 234 - suggestion: Spell out 'AFP' on first use
  • Line 241 - error: 'tunables' is repeated!
  • Line 246 - suggestion: Spell out 'CLI' on first use
  • Line 268 - suggestion: Spell out 'SME' on first use
  • Line 269 - suggestion: Spell out 'ECC' on first use
  • Line 282 - suggestion: Spell out 'BSG' on first use
  • Line 283 - suggestion: Spell out 'FBSG' on first use
  • Line 294 - suggestion: Spell out 'POSIX' on first use
  • Line 295 - suggestion: Spell out 'CIFS' on first use
  • Line 312 - suggestion: Spell out 'IEC' on first use
  • Lines 329, 411 - suggestion: Spell out 'ZIL' on first use
  • Lines 337, 2146 - suggestion: Spell out 'VPN' on first use
  • Line 340 - suggestion: Spell out 'DNS' on first use
  • Line 342 - error: 'hostname' is repeated!
  • Line 346 - suggestion: Spell out 'LDAP' on first use
  • Line 347 - suggestion: Spell out 'DDNS' on first use
  • Line 349 - suggestion: Spell out 'LLDP' on first use
  • Line 350 - suggestion: Spell out 'NDS' on first use
  • Line 351 - suggestion: Spell out 'NTP' on first use
  • Line 354 - suggestion: Spell out 'KMIP' on first use
  • Line 358 - suggestion: Spell out 'AFS' on first use
  • Line 361 - suggestion: Spell out 'AHCI' on first use
  • Line 362 - suggestion: Spell out 'ATA' on first use
  • Line 367 - suggestion: Spell out 'KVM' on first use
  • Line 368 - suggestion: Spell out 'MBR' on first use
  • Line 369 - suggestion: Spell out 'CSM' on first use
  • Line 382 - suggestion: Spell out 'SFTP' on first use
  • Line 383 - suggestion: Spell out 'UDP' on first use
  • Line 385 - suggestion: Spell out 'SNMP' on first use
  • Line 387 - suggestion: Spell out 'TLS' on first use
  • Line 405 - suggestion: Spell out 'MLC' on first use
  • Line 408 - suggestion: Spell out 'SDC' on first use
  • Line 410 - suggestion: Spell out 'TXG' on first use
  • Line 412 - suggestion: Spell out 'IOPS' on first use
  • Line 414 - suggestion: Spell out 'VDEV' on first use
  • Line 425 - suggestion: Spell out 'VSS' on first use
  • Line 427 - suggestion: Spell out 'OSX' on first use
  • Line 428 - error: 'deduplication' is repeated!
  • Line 435 - error: 'Filesystems' is repeated!
  • Line 445 - suggestion: Spell out 'EVO' on first use
  • Line 457 - suggestion: Spell out 'SHA' on first use
  • Line 457 - error: 'sha' is repeated!
  • Line 459 - suggestion: Spell out 'NVRAM' on first use
  • Line 464 - suggestion: Spell out 'JBOD' on first use
  • Line 465 - suggestion: Spell out 'MTTDL' on first use
  • Line 467 - error: 'Resilvering' is repeated!
  • Lines 479, 546 - suggestion: Spell out 'DFS' on first use
  • Line 494 - suggestion: Spell out 'PCI' on first use
  • Line 496 - suggestion: Spell out 'EDK' on first use
  • Line 497 - suggestion: Spell out 'INIT' on first use
  • Line 498 - suggestion: Spell out 'ALLOC' on first use
  • Line 517 - suggestion: Spell out 'TNS' on first use
  • Line 518 - warning: Prefer 'personal digital assistant' over 'agent'.
  • Line 525 - suggestion: Spell out 'QEMU' on first use
  • Line 530 - suggestion: Spell out 'ESC' on first use
  • Line 577 - suggestion: Spell out 'DMA' on first use
  • Line 595 - suggestion: Spell out 'SPN' on first use
  • Line 597 - suggestion: Spell out 'EZFS' on first use
  • Line 598 - suggestion: Spell out 'NOCAP' on first use
  • Line 614 - suggestion: Spell out 'EUI' on first use
  • Line 615 - suggestion: Spell out 'IQN' on first use
  • Line 620 - suggestion: Spell out 'SFP' on first use
  • Line 621 - suggestion: Spell out 'LSO' on first use
  • Line 622 - suggestion: Spell out 'LRO' on first use
  • Line 627 - suggestion: Spell out 'PSU' on first use
  • Line 629 - suggestion: Spell out 'LACP' on first use
  • Line 633 - suggestion: Spell out 'BMC' on first use
  • Line 635 - suggestion: Spell out 'EPYC' on first use
  • Lines 638, 710 - suggestion: Spell out 'AES' on first use
  • Lines 642, 644, 645 - suggestion: Spell out 'SAS' on first use
  • Line 646 - suggestion: Spell out 'STP' on first use
  • Line 652 - suggestion: Spell out 'BBU' on first use
  • Line 653 - suggestion: Spell out 'HBA' on first use
  • Line 657 - suggestion: Spell out 'LSI' on first use
  • Line 662 - suggestion: Spell out 'CRC' on first use
  • Line 663 - suggestion: Spell out 'UDMA' on first use
  • Line 666 - suggestion: Spell out 'DIF' on first use
  • Line 676 - error: 'multipath' is repeated!
  • Line 681 - suggestion: Spell out 'PMR' on first use
  • Line 682 - suggestion: Spell out 'CMR' on first use
  • Line 690 - suggestion: Spell out 'LZJB' on first use
  • Line 692 - suggestion: Spell out 'ZLE' on first use
  • Line 694 - suggestion: Spell out 'ZSTD' on first use
  • Line 706 - suggestion: Spell out 'TFTP' on first use
  • Line 717 - suggestion: Spell out 'MMC' on first use
  • Line 718 - suggestion: Spell out 'UTF' on first use
  • Line 733 - suggestion: Spell out 'FXP' on first use
  • Line 735 - suggestion: Spell out 'PASV' on first use
  • Line 737 - suggestion: Spell out 'FQDN' on first use
  • Line 738 - suggestion: Spell out 'PEM' on first use
  • Line 742 - error: 'IDENT' is repeated!
  • Line 743 - suggestion: Spell out 'IDENT' on first use
  • Line 748 - error: 'CheckIP' is repeated!
  • Line 761 - suggestion: Spell out 'SMTP' on first use
  • Line 763 - suggestion: Spell out 'FIPS' on first use
  • Line 784 - error: 'VMM' is repeated!
  • Line 785 - suggestion: Spell out 'VMM' on first use
  • Line 793 - suggestion: Spell out 'IPC' on first use
  • Line 797 - suggestion: Spell out 'SYSV' on first use
  • Line 803 - error: 'Chmod' is repeated!
  • Line 817 - error: 'autoconfigure' is repeated!
  • Line 820 - suggestion: Spell out 'BPF' on first use
  • Line 821 - suggestion: Spell out 'SLAAC' on first use
  • Lines 827, 2056 - suggestion: Spell out 'UUID' on first use
  • Line 831 - error: 'VDevs' is repeated!
  • Line 836 - suggestion: Spell out 'PBKDF' on first use
  • Line 849 - suggestion: Spell out 'PTR' on first use
  • Line 850 - suggestion: Spell out 'CTDB' on first use
  • Line 870 - suggestion: Spell out 'RBAC' on first use
  • Line 871 - warning: Avoid using 'TrueCommand's'
  • Line 872 - suggestion: Spell out 'CSV' on first use
  • Line 891 - error: Don't use 'backend'. See the A-Z word list for details.
  • Line 898 - suggestion: Spell out 'SAML' on first use
  • Line 925 - suggestion: Spell out 'CORS' on first use
  • Line 930 - suggestion: Spell out 'GORM' on first use
  • Line 933 - error: 'Ux' is repeated!
  • Line 938 - suggestion: Spell out 'SNI' on first use
  • Line 944 - warning: Avoid using 'API's'
  • Line 955 - error: 'Hyperconverged' is repeated!
  • Line 959 - suggestion: Spell out 'HCI' on first use
  • Line 1001 - suggestion: Spell out 'BTIME' on first use
  • Line 1025 - suggestion: Spell out 'NTB' on first use
  • Line 1033 - suggestion: Spell out 'KDC' on first use
  • Line 1040 - suggestion: Spell out 'RSS' on first use
  • Line 1044 - suggestion: Spell out 'NDP' on first use
  • Line 1055 - suggestion: Spell out 'STIG' on first use
  • Line 1064 - suggestion: Spell out 'OOB' on first use
  • Line 1069 - suggestion: Spell out 'OTP' on first use
  • Line 1075 - suggestion: Spell out 'HPE' on first use
  • Line 1121 - suggestion: Spell out 'GIDS' on first use
  • Line 1122 - suggestion: Spell out 'UIDS' on first use
  • Line 1132 - suggestion: Spell out 'PID' on first use
  • Line 1133 - suggestion: Spell out 'VID' on first use
  • Lines 1151, 2061, 2135 - suggestion: Spell out 'CMD' on first use
  • Line 1151 - suggestion: Spell out 'LINE' on first use
  • Line 1166 - warning: Prefer 'Gbps' over 'GBps'.
  • Lines 1167, 1168 - suggestion: Spell out 'IDP' on first use
  • Line 1217 - suggestion: Spell out 'SMR' on first use
  • Line 1218 - suggestion: Spell out 'ACPI' on first use
  • Line 1249 - suggestion: Spell out 'HSTS' on first use
  • Line 1259 - suggestion: Spell out 'CRIT' on first use
  • Line 1261 - suggestion: Spell out 'AMD' on first use
  • Line 1262 - suggestion: Spell out 'SVM' on first use
  • Line 1335 - suggestion: Spell out 'IXGBE' on first use
  • Line 1342 - suggestion: Spell out 'ECR' on first use
  • Line 1345 - suggestion: Spell out 'ASYNC' on first use
  • Line 1346 - suggestion: Spell out 'IOSQE' on first use
  • Line 1350 - error: 'MicroServer' is repeated!
  • Line 1355 - suggestion: Spell out 'IBS' on first use
  • Line 1369 - error: 'Rebalancing' is repeated!
  • Line 1383 - suggestion: Spell out 'WIP' on first use
  • Line 1387 - suggestion: Spell out 'TPC' on first use
  • Line 1441 - suggestion: Spell out 'SASL' on first use
  • Line 1459 - error: 'Webhook' is repeated!
  • Line 1463 - error: 'MatterMost' is repeated!
  • Line 1469 - error: 'ARN' is repeated!
  • Line 1470 - suggestion: Spell out 'ARN' on first use
  • Line 1471 - suggestion: Spell out 'SNS' on first use
  • Line 1478 - suggestion: Spell out 'MNMD' on first use
  • Line 1480 - suggestion: Spell out 'GMAIL' on first use
  • Line 1480 - error: 'gmail' is repeated!
  • Line 1483 - error: 'oauth' is repeated!
  • Line 1485 - suggestion: Spell out 'OAUTH' on first use
  • Line 1506 - suggestion: Spell out 'DTYP' on first use
  • Line 1517 - error: 'FSeriesStencil' is repeated!
  • Line 1536 - error: 'mydata' is repeated!
  • Lines 1546, 1606 - warning: Prefer 'GB' over 'Gb'.
  • Line 1567 - suggestion: Spell out 'OOBM' on first use
  • Line 1572 - suggestion: Spell out 'XOOBM' on first use
  • Line 1590 - error: 'NVDIMMUpdates' is repeated!
  • Line 1615 - error: 'gb' is repeated!
  • Line 1616 - warning: Prefer 'GB' over 'gb'.
  • Line 1651 - suggestion: Spell out 'HPC' on first use
  • Line 1668 - suggestion: Spell out 'BSOV' on first use
  • Line 1669 - error: 'misconfiguration' is repeated!
  • Line 1679 - error: 'discoverability' is repeated!
  • Line 1692 - suggestion: Spell out 'LXC' on first use
  • Line 1709 - suggestion: Spell out 'PUM' on first use
  • Line 1710 - suggestion: Spell out 'PRG' on first use
  • Line 1720 - suggestion: Spell out 'DACL' on first use
  • Line 1721 - suggestion: Spell out 'SACL' on first use
  • Line 1745 - suggestion: Spell out 'CSI' on first use
  • Line 1779 - suggestion: Spell out 'TUI' on first use
  • Line 1812 - suggestion: Spell out 'VLANS' on first use
  • Line 1827 - suggestion: Spell out 'NUMA' on first use
  • Lines 1834, 1849 - suggestion: Spell out 'MSR' on first use
  • Line 1836 - suggestion: Spell out 'GPU' on first use
  • Line 1836 - warning: Avoid using 'GPU's'
  • Line 1852 - suggestion: Spell out 'ROM' on first use
  • Line 1891 - error: 'hseries' is repeated!
  • Line 1896 - error: 'hseriesstencil' is repeated!
  • Line 1899 - error: 'hseriessov' is repeated!
  • Line 1901 - error: 'minirsov' is repeated!
  • Line 1915 - suggestion: Spell out 'NPUM' on first use
  • Line 1915 - error: 'npum' is repeated!
  • Line 1917 - error: 'nstencil' is repeated!
  • Line 1922 - suggestion: Spell out 'IANA' on first use
  • Line 1927 - suggestion: Spell out 'IEE' on first use
  • Line 1928 - error: 'ipsec' is repeated!
  • Line 1936 - suggestion: Spell out 'TTL' on first use
  • Line 1937 - suggestion: Spell out 'PIM' on first use
  • Line 1938 - error: 'stateful' is repeated!
  • Line 1943 - warning: 'publicly-accessible' doesn't need a hyphen.
  • Line 1943 - suggestion: Verify your use of 'accessible' with the A-Z word list.
  • Line 1944 - error: 'Unicast' is repeated!
  • Line 1956 - suggestion: Spell out 'NAA' on first use
  • Line 1958 - suggestion: Spell out 'FFF' on first use
  • Line 1965 - error: 'TruenasApps' is repeated!
  • Line 2030 - suggestion: Spell out 'TTY' on first use
  • Line 2059 - suggestion: Spell out 'ENV' on first use
  • Line 2061 - suggestion: Spell out 'SHELL' on first use
  • Line 2080 - suggestion: Spell out 'CHOWN' on first use
  • Line 2142 - suggestion: Spell out 'FSA' on first use
  • Line 2143 - error: 'zerotier' is repeated!
  • Line 2145 - error: 'VPN' is repeated!
  • Line 2147 - error: 'tailscale' is repeated!
  • Line 2158 - suggestion: Spell out 'SOV' on first use
  • Line 2166 - suggestion: Spell out 'DDT' on first use
  • Line 2166 - error: 'ddt' is repeated!
  • Line 2168 - error: 'ddts' is repeated!
  • Line 2170 - suggestion: Spell out 'ZAP' on first use
  • Line 2171 - suggestion: Spell out 'ARC' on first use
  • Line 2172 - error: 'dbit' is repeated!
  • Line 2174 - error: 'ZFSDeduplication' is repeated!
  • Line 2176 - error: 'ZFSPrimer' is repeated!
  • Line 2178 - error: 'ZILandSLOG' is repeated!
  • Line 2233 - suggestion: Spell out 'TPM' on first use
  • Line 2264 - suggestion: Spell out 'BMPUM' on first use
  • Line 2272 - error: 'iXVolumes' is repeated!
  • Line 2291 - suggestion: Spell out 'BLK' on first use
  • Line 2292 - suggestion: Spell out 'SCSI' on first use
  • Line 2303 - error: 'Cksum' is repeated!
  • Line 2372 - suggestion: Spell out 'GTX' on first use
  • Line 2373 - suggestion: Spell out 'RTX' on first use
  • Line 2374 - suggestion: Spell out 'GSP' on first use
  • Line 2383 - suggestion: Spell out 'CBDMA' on first use
  • Lines 2385, 2389 - warning: Prefer 'KB' over 'kB'.
  • Line 2392 - suggestion: Spell out 'QCOW' on first use
  • Line 2393 - suggestion: Spell out 'VDI' on first use
  • Line 2394 - suggestion: Spell out 'VHDX' on first use

content/GettingStarted/VersionNotes.md (364 issues)

  • Lines 46, 52, 56, 61, 67, 85, 86, 88, 95, 101, 125, 147, 158, 172, 178, 243, 248, 254, 270, 290, 313, 380 - suggestion: Avoid contractions in formal writing
  • Lines 56, 58, 60, 63, 64, 66, 68, 70, 72, 74, 76, 77, 78, 79, 81, 83, 85, 110, 112, 115, 116, 121, 122, 124, 125, 130, 131, 132, 133, 134, 135, 136, 138, 139, 141, 142, 143, 147, 148, 149, 154, 155, 156, 171, 174, 238, 267, 270, 271, 272, 282, 284, 290, 291 - suggestion: Spell out 'NAS' on first use
  • Line 57 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Line 57 - suggestion: Spell out 'TLS' on first use
  • Lines 61, 63, 80, 82, 84, 92, 101, 104, 110, 129, 147, 150, 172, 175, 233, 245, 252, 254, 255, 267, 289, 297, 302, 304, 305, 307, 310, 311, 313, 314, 315, 372 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 63 - suggestion: Spell out 'CORE' on first use
  • Line 63 - suggestion: Spell out 'BIOS' on first use
  • Lines 64, 141, 142, 251, 254 - suggestion: Spell out 'SMB' on first use
  • Line 71 - suggestion: Spell out 'WIP' on first use
  • Line 73 - warning: Prefer 'KB' over 'kB'.
  • Lines 73, 78 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 80 - suggestion: Spell out 'QED' on first use
  • Line 80 - suggestion: Spell out 'RAW' on first use
  • Line 80 - suggestion: Spell out 'VDI' on first use
  • Line 80 - suggestion: Spell out 'VHDX' on first use
  • Line 80 - suggestion: Spell out 'VMDK' on first use
  • Lines 85, 141 - suggestion: Spell out 'ACL' on first use
  • Line 85 - warning: Remove 'potentially' if it's not important to the meaning of the statement.
  • Line 86 - suggestion: Spell out 'PGP' on first use
  • Lines 92, 101, 158 - suggestion: Spell out 'BETA' on first use
  • Lines 92, 101, 107, 158 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Lines 104, 229, 310, 314, 315 - suggestion: Keep sentences under 30 words
  • Line 105 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 115 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 119, 132 - suggestion: Verify your use of 'Allows' with the A-Z word list.
  • Line 119 - suggestion: Spell out 'ACME' on first use
  • Line 119 - suggestion: Spell out 'DNS' on first use
  • Lines 125, 129, 233, 289, 290, 297, 302, 313, 314, 315 - suggestion: Spell out 'GPU' on first use
  • Line 130 - suggestion: Spell out 'FTP' on first use
  • Lines 135, 138, 172, 255, 272 - suggestion: Spell out 'ZFS' on first use
  • Line 136 - suggestion: Spell out 'DHCP' on first use
  • Lines 138, 272 - suggestion: Spell out 'ARC' on first use
  • Lines 143, 238 - suggestion: Spell out 'IDMAP' on first use
  • Line 143 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 144, 239 - suggestion: Spell out 'RID' on first use
  • Line 146 - suggestion: Spell out 'JSON' on first use
  • Line 146 - suggestion: Spell out 'RPC' on first use
  • Line 147 - suggestion: Spell out 'REST' on first use
  • Lines 150, 151, 245 - suggestion: Spell out 'SMART' on first use
  • Line 153 - suggestion: Spell out 'SCSI' on first use
  • Line 153 - suggestion: Spell out 'SAS' on first use
  • Line 229 - warning: Use first person (such as 'My') sparingly.
  • Line 238 - error: Don't use 'Backend'. See the A-Z word list for details.
  • Line 262 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 276 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.
  • Line 297 - suggestion: 'NVIDIA GPU Support' should use sentence-style capitalization.
  • Line 297 - warning: Avoid using acronyms in a title or heading.
  • Lines 304, 310 - suggestion: Spell out 'GTX' on first use
  • Lines 304, 305 - suggestion: Spell out 'RTX' on first use
  • Lines 305, 311 - suggestion: Spell out 'GSP' on first use
  • Line 315 - suggestion: Spell out 'IPMI' on first use
  • Line 363 - suggestion: Use Title Case for headings

content/SCALETutorials/Storage/ManagePoolsScale.md (268 issues)

  • Lines 20, 67, 161, 177, 256, 277 - suggestion: Keep sentences under 30 words
  • Lines 28, 32, 36, 37, 39 - suggestion: Spell out 'TRIM' on first use
  • Lines 37, 65, 118, 120, 134, 150, 151, 154, 155, 157, 161, 168, 171, 175, 183, 187, 188, 208, 209, 212, 274, 275, 302, 341, 344, 354 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 37, 63, 65, 99, 103, 106, 107, 128, 136, 150, 151, 154, 159, 169, 177, 179, 218, 219, 220, 221, 247, 266, 275, 277, 302, 304, 312, 344, 347, 350, 352, 354 - suggestion: Avoid contractions in formal writing
  • Line 37 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 39, 65, 155, 188, 208, 217, 308, 348, 359 - suggestion: Spell out 'ZFS' on first use
  • Line 74 - warning: Remove 'nearly' if it's not important to the meaning of the statement.
  • Line 86 - suggestion: Verify your use of 'alert' with the A-Z word list.
  • Lines 118, 128, 129, 130, 131, 133, 134, 150, 151, 154, 175, 191, 196, 209, 212, 219, 220, 221, 225, 227, 274, 275, 277, 302, 322, 341, 344, 352, 354, 356, 360, 363 - suggestion: Spell out 'VDEV' on first use
  • Line 120 - suggestion: Spell out 'SED' on first use
  • Lines 122, 277 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 128, 150, 154, 155, 157, 161, 168, 171, 175, 183, 187, 188, 191, 350, 354 - suggestion: Spell out 'RAIDZ' on first use
  • Lines 136, 142, 260, 360 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Lines 151, 219, 220 - suggestion: Spell out 'RAID' on first use
  • Lines 154, 325 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 155, 284 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 163 - suggestion: Verify your use of 'accessible' with the A-Z word list.
  • Line 180 - warning: Remove 'naturally' if it's not important to the meaning of the statement.
  • Line 187 - warning: Avoid using 'Salter's'
  • Line 221 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 221 - suggestion: Verify your use of 'ensure' with the A-Z word list.
  • Lines 279, 283 - suggestion: Spell out 'DDT' on first use
  • Line 341 - suggestion: Spell out 'SLOG' on first use
  • Line 354 - warning: Remove 'generally' if it's not important to the meaning of the statement.

static/llms.txt (179 issues)

  • Line 3 - suggestion: Spell out 'NAS' on first use
  • Lines 3, 41, 47, 72, 73, 74, 81, 94, 99, 101, 105, 109, 113, 117, 120, 126, 130, 132, 135, 144, 159, 174, 192, 196, 200, 204, 208, 212, 214, 218 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 5, 27 - suggestion: Keep sentences under 30 words
  • Lines 7, 10, 11, 12, 15, 16, 19, 20, 21, 22, 23, 25, 29, 56, 57, 58, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73, 74, 75, 76, 79, 80, 81, 82, 85, 86, 91, 92, 93, 94, 95, 98, 99, 100, 101, 104, 105, 108, 109, 112, 113, 116, 117, 120, 121, 122, 125, 126, 129, 130, 131, 132, 135, 140, 143, 144, 147, 148, 149, 150, 155, 158, 159, 162, 163, 164, 165, 170, 173, 174, 177, 178, 179, 180, 185, 186, 187, 188, 191, 192, 195, 196, 199, 200, 203, 204, 207, 208, 211, 212, 213, 214, 217, 218, 222 - suggestion: Avoid contractions in formal writing
  • Lines 15, 16, 25, 33, 36, 41, 45, 47, 94 - suggestion: Spell out 'CORE' on first use
  • Lines 25, 32, 35, 46, 47 - suggestion: Spell out 'SCALE' on first use
  • Line 42 - warning: Avoid using 'version's'
  • Line 72 - suggestion: Spell out 'ZFS' on first use
  • Line 74 - suggestion: Spell out 'ACL' on first use

content/SCALEUIReference/Storage/_index.md (91 issues)

  • Lines 22, 254, 278 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Lines 44, 104, 250, 258 - suggestion: Spell out 'ZFS' on first use
  • Lines 44, 69, 104, 153, 162, 301 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 64, 69, 101, 110, 114, 120, 135, 145, 202, 230, 236, 239, 240, 255, 265, 276 - suggestion: Avoid contractions in formal writing
  • Line 69 - suggestion: Spell out 'SMB' on first use
  • Lines 153, 154, 162, 202, 211, 278 - suggestion: Spell out 'VDEV' on first use
  • Line 154 - suggestion: Spell out 'RAID' on first use
  • Line 162 - suggestion: Keep sentences under 30 words
  • Line 174 - suggestion: Verify your use of 'above' with the A-Z word list.
  • Lines 198, 254, 258 - suggestion: Spell out 'TRIM' on first use
  • Line 222 - suggestion: Verify your use of 'alert' with the A-Z word list.
  • Line 225 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Lines 262, 265, 270, 283 - suggestion: Spell out 'DDT' on first use
  • Line 301 - suggestion: Spell out 'SAS' on first use
  • Line 301 - suggestion: Spell out 'SATA' on first use
  • Line 318 - warning: Remove 'nearly' if it's not important to the meaning of the statement.

CSV-TABLE-SETUP.md (61 issues)

  • Lines 5, 62, 65, 187, 193, 199, 209, 211, 226 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 5, 10, 65, 117, 128, 174, 187, 205, 209, 211 - suggestion: Spell out 'CSV' on first use
  • Line 5 - warning: Avoid using 'Here's'
  • Lines 5, 103, 107, 183, 199, 223 - suggestion: Avoid contractions in formal writing
  • Line 57 - suggestion: Spell out 'BETA' on first use
  • Line 57 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Lines 62, 116, 127, 128, 174, 187, 221, 226 - suggestion: Spell out 'JIRA' on first use
  • Lines 90, 103 - warning: Avoid using 'will'
  • Line 107 - warning: Avoid using 'What's'
  • Line 186 - suggestion: Use Title Case for headings
  • Line 193 - warning: Avoid using 'site's'
  • Lines 193, 199 - suggestion: Spell out 'CSS' on first use
  • Lines 205, 211 - suggestion: Verify your use of 'Ensure' with the A-Z word list.
  • Line 211 - warning: Remove 'properly' if it's not important to the meaning of the statement.
  • Line 221 - suggestion: Verify your use of 'sample' with the A-Z word list.

static/includes/25.10FeatureList.md (27 issues)

  • Lines 7, 32 - suggestion: Keep sentences under 30 words
  • Lines 12, 13 - suggestion: Spell out 'RDMA' on first use
  • Lines 13, 14, 18, 21, 26, 27, 28, 32 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 13 - suggestion: Avoid contractions in formal writing
  • Line 14 - suggestion: Spell out 'DHCP' on first use
  • Line 26 - warning: Avoid using 'NVIDIA's'
  • Lines 26, 27, 28 - suggestion: Spell out 'GPU' on first use
  • Line 32 - suggestion: Spell out 'ZFS' on first use

release-summary/release-summary-template.md (5 issues)

  • Lines 4, 5 - suggestion: Verify your use of 'BETA' with the A-Z word list.
  • Line 5 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 5 - suggestion: Spell out 'BETA' on first use

content/_index.md (4 issues)

  • Lines 39, 49 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Line 39 - suggestion: Spell out 'CORE' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@github-actions GitHub Actions
Copy link

Vale Style Guide Issues

📊 Summary: 302 issues found in changed files - 11 errors, 2 warnings, 289 suggestions

Changed files with issues:

static/llms.txt (120 issues)

  • Lines 5, 27 - suggestion: Keep sentences under 30 words
  • Line 7 - suggestion: Use active voice instead of passive voice
  • Lines 10, 11, 12, 15, 16, 19, 20, 21, 22, 23, 56, 57, 58, 61, 62, 63, 64, 65, 66, 67, 68, 69, 72, 73, 74, 75, 76, 79, 80, 81, 82, 85, 86, 91, 92, 93, 94, 95, 98, 99, 100, 101, 104, 105, 108, 109, 112, 113, 116, 117, 120, 121, 122, 125, 126, 129, 130, 131, 132, 135, 140, 143, 144, 147, 148, 149, 150, 155, 158, 159, 162, 163, 164, 165, 170, 173, 174, 177, 178, 179, 180, 185, 186, 187, 188, 191, 192, 195, 196, 199, 200, 203, 204, 207, 208, 211, 212, 213, 214, 217, 218, 222 - suggestion: Consider 'TrueNAS' instead of 'TrueNAS'
  • Lines 15, 16, 25, 33, 36, 41, 45, 47, 94 - suggestion: Spell out 'CORE' on first use
  • Lines 71, 75 - error: Use 'after' instead of 'once'

content/GettingStarted/VersionNotes.md (83 issues)

  • Line 41 - suggestion: Try to simplify this sentence.
  • Lines 46, 52, 61, 67, 86, 95, 101, 125, 147, 172, 178, 243, 248, 270, 290, 380 - suggestion: Use active voice instead of passive voice
  • Line 63 - suggestion: Spell out 'CORE' on first use
  • Line 63 - suggestion: Spell out 'BIOS' on first use
  • Line 73 - warning: Prefer 'KB' over 'kB'.
  • Line 80 - suggestion: Spell out 'QED' on first use
  • Line 80 - suggestion: Spell out 'RAW' on first use
  • Line 80 - suggestion: Spell out 'VDI' on first use
  • Line 80 - suggestion: Spell out 'VHDX' on first use
  • Line 80 - suggestion: Spell out 'VMDK' on first use
  • Line 85 - error: Use 'clear' instead of 'uncheck'
  • Line 86 - suggestion: Spell out 'PGP' on first use
  • Lines 88, 158 - error: Use 'login' instead of 'log in'
  • Lines 104, 229, 314, 315 - suggestion: Keep sentences under 30 words
  • Line 119 - suggestion: Spell out 'ACME' on first use
  • Lines 143, 238 - suggestion: Spell out 'IDMAP' on first use
  • Line 143 - error: Don't use 'backend'. See the A-Z word list for details.
  • Lines 144, 239 - suggestion: Spell out 'RID' on first use
  • Line 147 - suggestion: Spell out 'REST' on first use
  • Lines 150, 151, 245 - suggestion: Spell out 'SMART' on first use
  • Line 153 - suggestion: Spell out 'SCSI' on first use
  • Line 229 - warning: Use first person (such as 'My') sparingly.
  • Line 238 - error: Don't use 'Backend'. See the A-Z word list for details.
  • Line 254 - error: Use 'after' instead of 'once'
  • Line 262 - suggestion: 'Containers and Virtual Machines' should use sentence-style capitalization.
  • Line 276 - suggestion: 'TrueNAS Apps' should use sentence-style capitalization.
  • Line 297 - suggestion: 'NVIDIA GPU Support' should use sentence-style capitalization.
  • Lines 304, 310 - suggestion: Spell out 'GTX' on first use
  • Lines 304, 305 - suggestion: Spell out 'RTX' on first use
  • Lines 305, 311 - suggestion: Spell out 'GSP' on first use

content/SCALETutorials/Storage/ManagePoolsScale.md (54 issues)

  • Lines 20, 257, 277 - suggestion: Keep sentences under 30 words
  • Lines 28, 32, 37, 39 - suggestion: Spell out 'TRIM' on first use
  • Lines 37, 63, 99, 103, 159, 179, 221, 247, 275, 277, 312, 347, 350 - suggestion: Use active voice instead of passive voice
  • Line 37 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.
  • Line 65 - suggestion: Use 'rollback' instead of 'roll back'
  • Lines 122, 277 - suggestion: Use Oxford comma before 'and' in lists
  • Lines 128, 150, 154, 155, 157, 161, 168, 171, 175, 183, 350, 354 - suggestion: Spell out 'RAIDZ' on first use
  • Lines 219, 220 - suggestion: Spell out 'RAID' on first use
  • Line 341 - suggestion: Spell out 'SLOG' on first use

content/SCALEUIReference/Storage/_index.md (24 issues)

  • Line 29 - suggestion: 'Storage Dashboard' should use sentence-style capitalization.
  • Line 64 - suggestion: Use 'backup' instead of 'Back up'
  • Lines 110, 120, 145, 202, 236, 255, 265 - suggestion: Use active voice instead of passive voice
  • Line 154 - suggestion: Spell out 'RAID' on first use
  • Line 162 - suggestion: Keep sentences under 30 words
  • Lines 198, 258 - suggestion: Spell out 'TRIM' on first use
  • Line 225 - suggestion: Don't use language (such as 'disabled') that defines people by their disability.

CSV-TABLE-SETUP.md (13 issues)

  • Line 5 - error: Avoid contractions. Use 'here is' instead of 'Here's'.
  • Lines 90, 103 - suggestion: Avoid using 'will' - use present tense instead of future tense
  • Line 103 - suggestion: Use 'setup' instead of 'set up'
  • Line 107 - error: Avoid contractions. Use 'what is' instead of 'What's'.
  • Lines 183, 199 - suggestion: Use active voice instead of passive voice
  • Line 186 - suggestion: Use Title Case for headings
  • Lines 193, 199 - suggestion: Spell out 'CSS' on first use
  • Line 223 - suggestion: Use 'setup' instead of 'Set up'

static/includes/25.10FeatureList.md (6 issues)

  • Lines 7, 32 - suggestion: Keep sentences under 30 words
  • Lines 12, 13 - suggestion: Spell out 'RDMA' on first use

content/_index.md (1 issues)

  • Line 39 - suggestion: Spell out 'CORE' on first use

release-summary/release-summary-template.md (1 issues)

  • Line 5 - suggestion: Spell out 'BETA' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@DjP-iX DjP-iX removed the Technical Writer Review (MJ) A technical writer is reviewing the PR. label Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@micjohnson777 micjohnson777 micjohnson777 left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@DjP-iX @bugclerk @micjohnson777 @Mrt134